Skip to content

Simplify and update the project documentation - #2

Merged
mohityadav8 merged 13 commits into
python:3.15from
BHUVANSH855:docs/simplify-markdown
Oct 28, 2026
Merged

Simplify and update the project documentation#2
mohityadav8 merged 13 commits into
python:3.15from
BHUVANSH855:docs/simplify-markdown

Conversation

@BHUVANSH855

@BHUVANSH855 BHUVANSH855 commented Oct 22, 2026

Copy link
Copy Markdown
Collaborator

Fixes #1

This pull request simplifies the project documentation and updates it for the move to the python organization.

Changes

  • Add README.md (Punjabi) and README.en.md (English), linked to each other, as the Polish translation does.
  • Shorten CONTRIBUTING.md, STYLE_GUIDE.md, RULES.md, GLOSSARY.md and Transifex_Setup.md, so that each can be read in one sitting and has one clear job. The outdated project status, statistics and per-file lists are removed.
  • Fix the description of publishing: the documentation is built from this repository and published at https://docs.python.org/pa/, not "submitted upstream to CPython".
  • Remove PROJECT_REPORT.md.
  • Update the issue templates, the pull request template and config.yml. The links now point to python/python-docs-pa.
  • Replace the custom Code of Conduct with a pointer to the PSF Code of Conduct.

No .po files and no workflows are changed.

Notes

  • The READMEs link to https://docs.python.org/pa/. We would like to merge this after the first documentation build that includes pa, so that the link works.
  • The CC0 license sentence is kept as it was.

@BHUVANSH855 BHUVANSH855 added action: review Needs review form team. refactor labels Oct 22, 2026
@BHUVANSH855
BHUVANSH855 marked this pull request as draft October 22, 2026 17:59
@BHUVANSH855 BHUVANSH855 self-assigned this Oct 22, 2026
mohityadav8
mohityadav8 reviewed Oct 27, 2026
View reviewed changes

@mohityadav8 mohityadav8 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice simplification overall, links and the removed PROJECT_REPORT.md all check out clean. Two small things:

  1. GLOSSARY.md still uses # for every section (Core Python Terms, Data Types, etc.) while CONTRIBUTING.md/RULES.md/STYLE_GUIDE.md/Transifex_Setup.md all use # title + ## sections. Can you bump GLOSSARY.md's sections to ## for consistency?

  2. GLOSSARY.md references STYLE_GUIDE.md as plain backtick text in two places instead of a markdown link, unlike every other cross-reference in this PR. Worth making those [STYLE_GUIDE.md](STYLE_GUIDE.md) too.

@mohityadav8
mohityadav8 marked this pull request as ready for review October 27, 2026 20:39
@BHUVANSH855

BHUVANSH855 commented Oct 28, 2026

Copy link
Copy Markdown
Collaborator Author

Nice simplification overall, links and the removed PROJECT_REPORT.md all check out clean. Two small things:

  1. GLOSSARY.md still uses # for every section (Core Python Terms, Data Types, etc.) while CONTRIBUTING.md/RULES.md/STYLE_GUIDE.md/Transifex_Setup.md all use # title + ## sections. Can you bump GLOSSARY.md's sections to ## for consistency?
  2. GLOSSARY.md references STYLE_GUIDE.md as plain backtick text in two places instead of a markdown link, unlike every other cross-reference in this PR. Worth making those [STYLE_GUIDE.md](STYLE_GUIDE.md) too.

done, can you confirm and re check.

mohityadav8

This comment was marked as outdated.

Sign in to view

@mohityadav8
mohityadav8 merged commit 6295d18 into python:3.15 Oct 28, 2026
1 check passed
@BHUVANSH855
BHUVANSH855 deleted the docs/simplify-markdown branch October 28, 2026 07:56
@BHUVANSH855 BHUVANSH855 added action: merge Ready to merge. and removed action: review Needs review form team. labels Oct 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mohityadav8 mohityadav8 mohityadav8 approved these changes
@Yashraj-Jangra Yashraj-Jangra Awaiting requested review from Yashraj-Jangra

Assignees

@BHUVANSH855 BHUVANSH855

Labels

action: merge Ready to merge. refactor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Simplify and update the project’s documentation

2 participants

@BHUVANSH855 @mohityadav8